Summary

Key Points

• This is a breaking change
• New or existing documentation is updated

Description

This is a Draft PR for checking my work of adding swagger-ui is OK and I've finished most of the work except for polishing the description of each annotation.

Using swagger-ui, first, we need to install swag cli by

$ go get -u github.com/swaggo/swag/cmd/swag

also , we need to add swag cli to the path

and also need two package

# gin-swagger  is  a middleware package
$ go get github.com/swaggo/gin-swagger
# swagger  is an inner-config package
$ go get github.com/swaggo/gin-swagger/swaggerFiles

these have been written in go.mod.

My work is adding annotations to /api directory. In api.go,we need to do some basic settings and register swagger router.
In Controler Files, we also need to add annotations for each function.

After that , run swag init --parseDependency --parseInternal -o ./api/docs -g ./api/api.go to generate swag-docs.
--parseDependency --parseInternal aims to find models outside file. -o ./api/docs sets the generated docs in ./api/dos directory and -g ./api/api.go make swagger search api.go as an Enterance.

the command will generate three files as docs.go , swagger.json and swagger.yaml . These files are generated autoly
and can be ignored in formal version by using CI/CD tools.

Then we can see swagger page by enter URL http://localhost:8080/swagger/index.html#/. like

In API we can see the input format and output format.

We can also try your own input data in this page.

Does this close any open issues?

related to #292

Current Behavior

finish most of this feat

New Behavior

continue processing the description.

Screenshots

Include any relevant screenshots here.

Other Information

Any other information that is important to this PR.